You are here: GCF VBScript functions > GCFNotificationMessage function

GCFNotificationMessage function

User-definable function to calculate the email message that is sent on import of a document at the destination site.

Syntax

Public Function GCFNotificationMessage(NotifyMessage, bEnlist, _
                bTransferOwnership, SourceSite, DocName, BrcName)
Parameters
Name Description

NotifyMessage

The notification message as set when the document was exported from the source vault.

bEnlist

True if the transfer is an enlistment of the local vault.

bTransferOwnership

True if ownership is transferred to the local vault.

SourceSite

The share name of the source site.

DocName

The name of the document in the received briefcase.

BrcName

The name of the briefcase being imported.

Return value

A variant array with two members. The first is the subject of the message, and the second is the body text.

Remarks

The Document object in VBScript is set to the document that was just imported. This function is defined by importing the file C:\Program Files (x86)\BC-Meridian\Program\GCF\Configuration\GCFNotificationMessage.bas to the event script of the vault.

Example

Function GCFNotificationMessage(NotifyMessage, bEnlist, bTransferOwnership, _
                                SourceSite, DocName, BrcName)
  Dim ThisSite, Subj, msg
  ThisSite = vault.Table("ThisVaultShareName").GetValues()(0, 0)
  If bEnlist Then   
      subj = "GCF Enlistment Notification"   
      msg = "Document '" & DocName & _
      "' has been successfully imported into GCF vault '" & ThisSite & "'" & _
      " from '" & SourceSite & "'" & _
      vbCrLf & IIf(bTransferOwnership, "With", "Without") & " ownership transfer."

    ElseIf bTransferOwnership Then   
      subj = "GCF Ownership Transfer Notification"   
      msg = "Ownership for the document '" & DocName & _
      "' has been successfully transferred into GCF vault '" & ThisSite & "'" & _
      " from '" & SourceSite & "'"
  End If
  msg = msg & vbCrLf & "Briefcase: '" & BrcName & "'"
  If NotifyMessage <> "" Then
    msg = msg & vbCrLf & vbCrLf & "Comments: " & NotifyMessage
  End If 
  ' Return subject and message body:
  Dim rv(1)
  rv(0) = subj
  rv(1) = msg
  GCFNotificationMessage = rv
End Function

Related concepts

Understanding email notification

Related tasks

Configuring the general settings

Related information

GCFEmails table

GCFInitiateTransfer function


www.bluecieloecm.com